Получение контентных блоков

С помощью контентных блоков вы можете менять отдельные части сайта без новой сборки: баннер, текст, изображение, ссылку или составную секцию.

Для запросов нужен App Token приложения. Если блок ещё не создан, добавьте его через API управления блоками или пройдите быстрый старт CMS.

Какой ключ использовать

Для новых интеграций получайте блок по identifier. Этот ключ задаёте вы, поэтому его удобно хранить в коде и использовать в разных средах.

Gigma не проверяет уникальность identifier. Следите, чтобы внутри одного Application каждому публичному ключу соответствовал только один блок: при совпадении API вернёт первый найденный объект.

После создания нового блока code может быть null: метод создания его не принимает и не генерирует. Метод чтения по code используйте только для старых данных или после того, как назначили блоку свободный числовой код через PUT /api/applications/{application_id}/blocks/{id}.

Не переносите id или code между приложениями: одинаковые значения не означают, что блоки содержат одинаковые данные.

Получить блок по identifier

Метод: GET
URL: https://api.gigma.ru/api/counterparty/blocks/id/{identifier}
Авторизация: App Token
Headers: Token: {application_token}
Успешный ответ: 200

Чтобы получить блок по постоянному ключу, передайте identifier в адресе запроса.

Параметры пути

identifier (string, обязательный) — ключ, заданный при создании блока.

Пример запроса

GET /api/counterparty/blocks/id/home-hero HTTP/1.1
Host: api.gigma.ru
Token: <application_token>
Accept: application/json

Ответ

{
	"block": {
		"id": 42,
		"code": "10",
		"identifier": "home-hero",
		"name": "Главный баннер",
		"avatar": {
			"id": 2828,
			"name": "hero-avatar.png",
			"type": {
				"id": 1,
				"name": "Документ",
				"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
				"created_at": "2024-03-27T07:00:46.000000Z"
			},
			"path": "https://api.gigma.ru/storage/uploads/hero-avatar.png",
			"link": null,
			"created_at": "2026-08-14T08:00:00.000000Z",
			"updated_at": "2026-08-14T08:00:00.000000Z"
		},
		"block_type": {
			"id": 3,
			"name": "Картинка",
			"avatar": "https://api.gigma.ru/storage/uploads/image-profile-2.svg",
			"created_at": "2025-01-23T09:47:38.000000Z"
		},
		"link": "/catalog",
		"file": {
			"id": 2827,
			"name": "hero.png",
			"type": {
				"id": 1,
				"name": "Документ",
				"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
				"created_at": "2024-03-27T07:00:46.000000Z"
			},
			"path": "https://api.gigma.ru/storage/uploads/hero.png",
			"link": null,
			"created_at": "2026-08-14T08:00:00.000000Z",
			"updated_at": "2026-08-14T08:00:00.000000Z"
		},
		"text": null,
		"parent": {
			"id": 8,
			"code": "1",
			"name": "Главная"
		},
		"children": [
			{
				"id": 43,
				"code": "11",
				"identifier": "home-hero-caption",
				"name": "Подпись баннера",
				"avatar": null,
				"block_type": {
					"id": 1,
					"name": "Обычный текст",
					"avatar": "https://api.gigma.ru/storage/uploads/image-profile-1.svg",
					"created_at": "2025-01-23T09:47:38.000000Z"
				},
				"link": null,
				"file": null,
				"text": "Новая коллекция",
				"parent": {
					"id": 42,
					"code": "10",
					"name": "Главный баннер"
				},
				"children": [],
				"created_at": "2026-08-14T08:30:00.000000Z"
			}
		],
		"created_at": "2026-08-14T08:00:00.000000Z"
	}
}

В поле block вы получите содержимое блока и его связи. Поле code возвращается строкой или null. Если блок составной, дочерние элементы находятся в children; каждый дочерний элемент имеет ту же структуру.

Ошибки

401 — App Token отсутствует, недействителен или отключён.
404 — блок с таким identifier не найден в текущем приложении.

Получить блок по code

Метод: GET
URL: https://api.gigma.ru/api/counterparty/blocks/{code}
Авторизация: App Token
Headers: Token: {application_token}
Успешный ответ: 200

Чтобы получить блок по назначенному числовому коду, передайте code в адресе запроса.

Параметры пути

code (integer, обязательный) — числовой код, ранее сохранённый у блока.

Пример запроса

GET /api/counterparty/blocks/10 HTTP/1.1
Host: api.gigma.ru
Token: <application_token>
Accept: application/json

Ответ

{
	"block": {
		"id": 42,
		"code": "10",
		"identifier": "home-hero",
		"name": "Главный баннер",
		"avatar": {
			"id": 2828,
			"name": "hero-avatar.png",
			"type": {
				"id": 1,
				"name": "Документ",
				"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
				"created_at": "2024-03-27T07:00:46.000000Z"
			},
			"path": "https://api.gigma.ru/storage/uploads/hero-avatar.png",
			"link": null,
			"created_at": "2026-08-14T08:00:00.000000Z",
			"updated_at": "2026-08-14T08:00:00.000000Z"
		},
		"block_type": {
			"id": 3,
			"name": "Картинка",
			"avatar": "https://api.gigma.ru/storage/uploads/image-profile-2.svg",
			"created_at": "2025-01-23T09:47:38.000000Z"
		},
		"link": "/catalog",
		"file": {
			"id": 2827,
			"name": "hero.png",
			"type": {
				"id": 1,
				"name": "Документ",
				"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
				"created_at": "2024-03-27T07:00:46.000000Z"
			},
			"path": "https://api.gigma.ru/storage/uploads/hero.png",
			"link": null,
			"created_at": "2026-08-14T08:00:00.000000Z",
			"updated_at": "2026-08-14T08:00:00.000000Z"
		},
		"text": null,
		"parent": {
			"id": 8,
			"code": "1",
			"name": "Главная"
		},
		"children": [
			{
				"id": 43,
				"code": "11",
				"identifier": "home-hero-caption",
				"name": "Подпись баннера",
				"avatar": null,
				"block_type": {
					"id": 1,
					"name": "Обычный текст",
					"avatar": "https://api.gigma.ru/storage/uploads/image-profile-1.svg",
					"created_at": "2025-01-23T09:47:38.000000Z"
				},
				"link": null,
				"file": null,
				"text": "Новая коллекция",
				"parent": {
					"id": 42,
					"code": "10",
					"name": "Главный баннер"
				},
				"children": [],
				"created_at": "2026-08-14T08:30:00.000000Z"
			}
		],
		"created_at": "2026-08-14T08:00:00.000000Z"
	}
}

Ошибки

401 — App Token отсутствует, недействителен или отключён.
404 — блок с таким code не найден в текущем приложении.

Как обработать ответ

Тип блока находится в block_type. В зависимости от типа полезные данные будут в text, file или link.

Если у блока есть дочерние элементы, Gigma вернёт их в children. Поле parent содержит ID, код и название родительского блока.

Проверяйте ссылки перед переходом. Если API вернул 404 или временно недоступен, покажите пользователю резервный вариант секции.